Cis Tasks FilterSpec

The Cis Tasks FilterSpec schema contains properties used to filter the results when listing tasks (see POST /cis/tasks?action=list). If multiple properties are specified, only tasks matching all of the properties match the filter.

Currently at least one of Cis Tasks FilterSpec.tasks or Cis Tasks FilterSpec.services must be specified and not empty.

This schema was added in vSphere API 6.7.1.

JSON Example

{
    "tasks": [
        "string"
    ],
    "services": [
        "string"
    ],
    "operations": [
        "string"
    ],
    "status": [
        "string"
    ],
    "targets": [
        {
            "type": "string",
            "id": "string"
        }
    ],
    "users": [
        "string"
    ]
}

array of string

tasks

Optional

Identifiers of tasks that can match the filter.

This property was added in vSphere API 6.7.1.

This property may be missing or null if services is specified. Currently all tasks must be from the same provider. If missing or null or empty, tasks with any identifier will match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.cis.task. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.cis.task.

array of string

services

Optional

Identifiers of services. Tasks created by operations in these services match the filter (see Cis Task CommonInfo.service).

This property was added in vSphere API 6.7.1.

This property may be missing or null if tasks is specified. Currently all services must be from the same provider. If this property is missing or null or empty, tasks for any service will match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vapi.service. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vapi.service.

array of string

operations

Optional

Identifiers of operations. Tasks created by these operations match the filter (see Cis Task CommonInfo.operation).

Note that an operation identifier by itself is not globally unique. To filter on an operation, the identifier of the service interface containing the operation should also be specified in services.

This property was added in vSphere API 7.0.0.0.

If missing or null or empty, tasks associated with any operation will match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vapi.operation. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vapi.operation.

array of string

status

Optional

Status that a task must have to match the filter (see Cis Task CommonInfo.status).

For more information see: Cis Task Status.

This property was added in vSphere API 6.7.1.

If missing or null or empty, tasks with any status match the filter.

array of Vapi Std DynamicID

targets

Optional

Identifiers of the targets the operation for the associated task created or was performed on (see Cis Task CommonInfo.target).

This property was added in vSphere API 6.7.1.

If missing or null or empty, tasks associated with operations on any target match the filter.

array of string

users

Optional

Users who must have initiated the operation for the associated task to match the filter (see Cis Task CommonInfo.user).

This property was added in vSphere API 6.7.1.

If missing or null or empty, tasks associated with operations initiated by any user match the filter.